home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 2.iso / STUTTGART / UTIL / DESKTOP / MEGABOARD / MegaBoard2 / Docs / Guide next >
Text File  |  1996-02-13  |  22KB  |  529 lines
  1.                          ****************************
  2.                          *--------------------------*
  3.                          *- MegaBoard Version 2.07 -*
  4.                          *--------------------------*
  5.                          ****************************
  6.  
  7. Please note this program is SHAREWARE, please refer to the end of this file
  8. for details.
  9.  
  10. ----------------
  11. - Introduction -
  12. ----------------
  13. MegaBoard 2 is a desktop Backdrop utility designed as a replacement for the
  14. Pinboard Module supplied with Risc OS 3. It offers a number of extra features
  15. and enhancements. (MegaBoard 2 will be referred to as MegaBoard from here on)
  16.  
  17. -----------------------
  18. - System Requirements -
  19. -----------------------
  20. This version of MegaBoard will work with all versions of Risc OS from 3.1
  21. onwards.
  22.  
  23. ---------------
  24. - Terminology -
  25. ---------------
  26. "MegaBoard" refers to this Program.
  27. "Pinboard"  refers to the Risc OS 3 utility.
  28.  
  29. -----------------------------------
  30. - Upgrading from earlier versions -
  31. -----------------------------------
  32. - Version 2.00 has been completely rewritten in C, there are many small
  33.   enhancements, too numerous to list here, please experiment.
  34. - Note that cycled backdrops are not supported in this release, later releases
  35.   will include a secondary application that implements cyling backdrops.
  36. - The interface for special icons has been slightly modified, icons written
  37.   for earlier versions will work, as long as they do not attempt to modify
  38.   their own size or position. I am not currently aware of any third party
  39.   special icons that do this, but if you are unsure please contact the author
  40.   of the special icon before using it with this version of MegaBOard. Naturally
  41.   the four special icons supplied have been modified to work correctly.
  42. - The format of the configuration files has changed slightly, so files created
  43.   by versions earlier than 2.00 can no longer be used.
  44.  
  45. ---------------
  46. - Starting up -
  47. ---------------
  48. MegaBoard can be Loaded by double clicking on the icon !MegaBoard in the
  49. directory viewer.
  50. When MegaBoard is first loaded it is necessary for it to reinitialise the
  51. Filer. This will cause all open Filer Windows to be closed. Installing
  52. MegaBoard into the boot sequence (see below) avoids this Problem.
  53.  
  54. -------
  55. - Use -
  56. -------
  57.  
  58. Filer icons
  59. -----------
  60. Placing Filer icons on MegaBoard:
  61. An icon is placed on MegaBoard by dragging it from a Filer window and
  62. dropping it on MegaBoard.
  63.  
  64. Moving:
  65. An icon dragged and dropped onto another part of MegaBoard will be moved
  66. to that position unless it is locked (see below).
  67.  
  68. Positioning and Grid lock:
  69. Normally filer icons are positioned at the exact position they were dropped
  70. on MegaBoard. However if the Grid lock option is on then any icons
  71. placed or moved on MegaBoard will be positioned at the closest grid
  72. point. The Grid lock option is toggled by choosing the Grid lock menu item
  73. on MegaBoard menu.
  74. Note: Grid lock only applies to Filer icons placed or moved when it is
  75.       activated. Activating Grid lock has no effect on existing icons unless
  76.       they are moved.
  77.       Grid lock has no effect on special or window icons
  78.  
  79. Double-clicking:
  80. Double-clicking Select on an icon placed in the manner described above has
  81. the same effect as it would in a Filer window. Double-clicking Adjust is
  82. identical unless the 'Adjust Removes' option is set in the main menu, in
  83. which case the icon is also removed from MegaBoard.
  84.  
  85. Dragging:
  86. Icons dragged from MegaBoard and dropped on other applications (including the
  87. Filer) are also treated in the same way as icons dragged from a Filer window
  88. with the exception of dragging with Shift copying not moving the selected
  89. items.
  90. Dragging with Adjust additionally removes the items from MegaBoard if the
  91. 'Adjust Removes' option is set in the main menu.
  92.  
  93. Selecting:
  94. Filer icons can be selected in several ways:
  95. 1. Clicking Select on an unselected icon selects it and deselects all others.
  96.    Clicking Select on a selected icon has no effect.
  97. 2. Clicking Adjust on an unselected icon selects it.
  98.    Clicking Adjust on a selected icon deselects it.
  99. 3. Dragging Select on MegaBoard produces a bounding box within which all
  100.    icons are selected.
  101. 4. Dragging Adjust on MegaBoard produces a bounding box within which all
  102.    unselected icons are selected and selected icons are deselected.
  103. 5. Clicking Menu over an icon when none are selected selects that icon and
  104.    opens the main menu.
  105.  
  106. Information:
  107. Information on a Filer icon can be obtained by choosing the 'Info' option
  108. from the 'File' Submenu.
  109.  
  110. Removing:
  111. Filer icons that are no longer required can be removed from MegaBoard by
  112. selecting them and choosing the 'Remove' option from the 'File' submenu.
  113.  
  114. Opening the parent directory:
  115. The parent directory of a file or directory can be opened by choosing the
  116. 'Open Directory' option from the 'File' submenu.
  117.  
  118. Locking:
  119. An icon can be locked to MegaBoard to prevent it from being moved. Locking is
  120. toggled by choosing the 'Lock' option in the 'File' submenu. Locked filer
  121. icons can still be dragged, but dropping them back onto MegaBoard will not
  122. move them.
  123.  
  124. Moving to the front or back:
  125. Should an icon be obscuring another it is possible to move it to the back of
  126. the heap by choosing the 'Back' option from the 'File' submenu. Similarly an
  127. icon can be moved to the front by choosing the 'Front' option from the same
  128. submenu.
  129.  
  130. Altered files:
  131. If a file whose icon is on MegaBoard, is deleted or renamed the icon will be
  132. automatically removed from MegaBoard. Similarly if the filetype is altered,
  133. the MegaBoard icon will be updated to reflect the change.
  134.  
  135. Window icons
  136. ------------
  137. iconising application windows:
  138. Clicking on a window's close icon with Shift will cause it to be reduced to a
  139. MegaBoard icon. An exception is filer windows, these will only be handled in
  140. the same way if the 'iconise dirs' option is set in the MegaBoard menu,
  141. otherwise the icon of the parent directory is placed on MegaBoard as a Filer
  142. icon (see above).
  143.  
  144. Removing:
  145. Window icons cannot be removed using the MegaBoard menu. Double clicking
  146. Adjust or Select on a window icon brings the window to the front and removes
  147. the icon. The icon will also be removed if the window's parent application
  148. closes or reopens the window.
  149.  
  150. Accessing menus of iconised windows:
  151. iconised windows may have menus associated with them, if this is the case
  152. then clicking Menu while pressing Shift opens this menu.
  153.  
  154. Note: Window icons cannot be locked.
  155.  
  156. Backdrops
  157. ---------
  158. To create a backdrop execute the following steps:
  159. 1. Choose the 'Make' option from the backdrop submenu. This opens the
  160.    backdrop setup dialogue box.
  161. 2. Drag the object (directory (see below), sprite, or draw file) containing
  162.    the backdrop to the appropriately marked icon.
  163. 3. Select the desired horizontal and vertical positioning icons.
  164. 4. Click on 'OK'.
  165.  
  166. To remove a backdrop choose the 'Remove' option from the Backdrop submenu.
  167. If the 'Autoscale' option in the backdrop setup is selected then the backdrop
  168. will be scaled to always occupy the same number of OS-units not pixels on the
  169. screen in the same way as icons. E.g. a backdrop in the standard 1600x600
  170. mode will be scaled to the same size it would be if the resolution were
  171. 1600x1200. This sounds more complicated than it is the effect of the
  172. autoscale option is best understood by experimentation.
  173. When a backdrop is created, it is possible that part of the screen becomes
  174. corrupted and is then redrawn, this is normal and not a bug.
  175.  
  176. Optimisation:
  177. Normally MegaBoard will optimise backdrops to use as little memory as possible
  178. sometimes this is undesirable, as a gain in memory will result in a loss of
  179. redraw speed. Selcting the 'Speed optimise' option on the backdrop setup
  180. dialogue box will cause MegaBoard to attempt to manage the backdrop in such
  181. a way that it is redraw as fast as possible, if necessary at the cost of an
  182. increase in memory usage.
  183.  
  184. Changing the background colour:
  185. To change the colour of the background choose the 'Colour' option from the
  186. Backdrop submenu. This will produce a standard colour picker, which
  187. can be used to select a new colour. The colour can then be chosen using either
  188. a standard colour selector, if it is available (under Risc OS 3.5 or greater it
  189. is included in ROM) or MegaBoard's own colour selector if it is not.
  190.  
  191.  
  192. Special icons
  193. -------------
  194. Special icons are icons which can perform a variety of additional functions,
  195. and can be defined by users with a knowledge of ARM code programming. See the
  196. files 'ProgGuide' and 'ProgTut' for instructions on how to create new special
  197. icons.
  198.  
  199. Placing:
  200. Special icons are placed on MegaBoard by choosing their menu items from
  201. the Special icon submenu.
  202.  
  203. Locking:
  204. Special icons can be locked in the same way as filer icons, but contrary to
  205. filer icons they cannot be dragged at all when they are locked.
  206.  
  207. Moving to the front or back:
  208. Special icons can be moved to the front or back the same way as filer icons
  209. (described above).
  210.  
  211. This version of MegaBoard includes the following special icons:
  212.  
  213. Pointer:
  214. Displays the current position of the mouse pointer in screen coordinates.
  215.  
  216. Time:
  217. Displays the current time in the format defined in its Format parameter (see
  218. below for how to edit parameters). The Format parameter is a standard time
  219. and date format string as described on page 327 of the RISC OS 3 User Guide. 
  220. If the format string contained a syntax error the icon will not display the
  221. time, but the word "ERROR" instead.
  222.  
  223. Gobbler:
  224. Deletes files dragged onto it.
  225.  
  226. Acornlogo:
  227. Displays an Acorn logo in the top-right corner of the screen. (Logo sprite by
  228. Adam Goodfellow (adam@comptech.demon.co.uk)).
  229.  
  230. Parameters:
  231. Some special icons (e.g. Time) can be configured by the user. This is
  232. accomplished by editing its parameters in the following manner:
  233. A special icon has parameters associated with it if its menu item has a
  234. submenu arrow pointing to a parameter dialogue box which contains a writaeble
  235. icon for each parameter. Initially these icons contain the default values for
  236. the parameters. If you wish to change any of them edit the value displayed.
  237. When all parameters contain the desired values place the icon by clicking on
  238. the 'Create' icon in the dialogue box.
  239.  
  240. Surfaces
  241. --------
  242. Entering a name into the 'New surface' submenu then choosing that menu item
  243. creates an icon resembling a directory. Double-clicking this icon appears to
  244. clear the board,in reality however, it has merely caused a new 'surface' to
  245. be displayed. Double-clicking Adjust on the background will return to the
  246. previous surface and the icons will reappear.
  247. Icons including additional surface icons can be placed on this new surface
  248. as before. Nested surfaces can be viewed in a similar manner to
  249. subdirectories in filer windows, double-clicking Adjust on the background
  250. always moves to the parent surface.
  251. Removing a surface icon recursively removes all icons on that surface. If one
  252. or more of them is a window icon, then those windows will be reopened.
  253.  
  254. Removing an icon's restriction to a surface:
  255. Normally an icon be restricted to the surface in which it was created,
  256. however it may sometimes be desirable to have anicon visible on all surfaces.
  257. For example the AcornLogo special icon would not be much use if it were
  258. only visible on one surface. In order to make an icon visible on all
  259. surfaces set the 'All surfaces' option by choosing its entry in the
  260. 'File' submenu.
  261. Note: This option is not available for window, or surface icons.
  262.  
  263. The Overview Window
  264. -------------------
  265. Opening:
  266. The overview window is opened by choosing the 'Overview' option from the
  267. MegaBoard Menu.
  268.  
  269. Function:
  270. Displayed on the overview window is a "map" of MegaBoard. The white rectangle
  271. around the centre represents the visible area i.e. the screen excluding the
  272. icon bar. The surrounding light grey represents the area invisible to the
  273. user.
  274.  
  275. Icons:
  276. Icons are represented on the overview menu by small colour coded rectangles,
  277. the following is a table of icon types and their colour codes:
  278.  
  279.   Red......File
  280.   Blue.....Directory
  281.   Green....Application
  282.   Magenta..iconised window
  283.   Black....Special icon
  284.   Cyan.....Surface icon
  285.  
  286. Dragging icons on the on overview window:
  287. Dragging an overview window icon and dropping it back onto the overview
  288. window has the same effect as dragging it would on the MegaBoard i.e. the
  289. icon is moved to the position it is dropped on. Dragging an overview window
  290. icon to a different window has no effect.
  291. Unless the 'Move locked' radio icon on the overview window is selected, an
  292. attempt to drag a locked icon will have no effect.
  293. If the 'Move locked' radio icon is selected, icons can be dragged and moved
  294. regardless of whether or not they are locked. However this only applies to
  295. the icons' representations on the overview window, restrictions to dragging
  296. locked icons on the MegaBoard remain.
  297.  
  298. The Spyhole
  299. -----------
  300. Backdrop programs of this nature generally have one major flaw. When the
  301. desktopis cluttered with windows, it is very inconvient to access icons on
  302. the backdrop. In order to avoid this, MegaBoard provides a "Spyhole".
  303.  
  304. Pressing Alt-F1 opens a small window in the centre of the screen. This
  305. window allows you to see and click "through" other windows to MegaBoard. It
  306. can be dragged like any other window, allowing access to MegaBoard's entire
  307. surface. So rather than moving several windows in order to access MegaBoard's
  308. icons it is possible to accomplish this using the spyhole. While The Spyhole
  309. is open, it will always remain ath te top of the window stack.
  310.  
  311. * Commands
  312. ----------
  313. MegaBoard's support module provides two * Commands, '*Pin' and '*Backdrop'.
  314.  
  315. '*Pin <Pathname> <x_coordinate> <y_coordinate>' places the filer icon
  316. specified by <Pathname> on the MegaBoard at the given coordinates.
  317. Example: *Pin adfs::harddisc4.$.fred 200 200
  318.  
  319. '*Backdrop [-options] [Pathname]' creates a backdrop, whose positioning is
  320. determined by the options as follows:
  321.  
  322. '-Centre'  centres the backdrop horizontally and vertically.
  323. '-HCentre' centres the backdrop horizontally.
  324. '-VCentre' centres the backdrop vertically.
  325.  
  326. '-Scale'  Scales the backdrop horizontally and vertically.
  327. '-HScale' Scales the backdrop horizontally.
  328. '-VScale' Scales the backdrop vertically.
  329.  
  330. '-Tile'  Makes the backdrop tiled horizontally and vertically.
  331. '-HTile' Makes the backdrop tiled horizontally.
  332. '-HTile' Makes the backdrop tiled vertically.
  333.  
  334. '-Top'    Aligns the top of the backdrop picture with the top of the screen.
  335. '-Bottom' Aligns the bottom of the backdrop picture with the top of the icon
  336.           bar.
  337.  
  338. '-Left'  Aligns the left of the backdrop picture with the left of the screen.
  339. '-Right' Aligns the right of the backdrop picture with the right of the
  340.          screen.
  341.  
  342. '-Remove' Removes the current backdrop (if present).
  343.  
  344. '-Autoscale' Has the same effect as selecting the 'Autoscale' option in the
  345.              backdrop setup dialogue box.
  346. '-SpeedOpt' Has the same effect as selecting the 'SpeedOpt' option in the
  347.             backdrop setup dialogue box.
  348.  
  349. This list of options is in order of reverse priority i.e. if two or more
  350. contradictory options are specified (e.g. -hscale and -hcentre) in one
  351. command the one lowest on the above list will take effect.
  352.  
  353. Example: *Backdrop -HCentre -VScale adfs::4.$.Pic0
  354.          Will use the picture in the file 'adfs::4.$.Pic0' as a backdrop. The
  355.          picture will be horizontally centred and vertically scaled.
  356.  
  357. Installing MegaBoard in the boot sequence
  358. -----------------------------------------
  359. With Risc OS 3.5 onwards:
  360. Run the supplied !Install applicationto install MegaBoard in the boot
  361. sequence. It can be removed using the !UnInstall application.
  362.  
  363. With earlier versions of Risc OS:
  364. If your system does not yet have a !Boot application it is necessary to
  365. create one see the Risc OS User Guide for details on how to do this.
  366.  
  367. Copy the PinSupport module from the !MegaBoard application directory into the
  368. !Boot directory and add the following line to the !Boot.!Run file:
  369.  
  370.   RMLoad <Obey$Dir>.PinSupport
  371.  
  372. Note: installing MegaBoard into the boot sequence removes the need for the
  373.       filer to be reinitialised when it is first run.
  374.  
  375. -----------
  376. - Credits -
  377. -----------
  378. Thanks are due to the following for testing, ideas and nagging for more
  379. features:
  380. Pavendip Birah (IRC nickname: PAV)
  381. Asif Nazir (IRC nickname: Hawks)
  382.  
  383. And to the following:
  384. Eli-Jean Leyssens (IRC nickname: Zorack) for the majority of the
  385. conversion of MegaBoard 1 to Risc OS 3.1.
  386. Roalt Zijlstra for desiging the multiple file sprite for Risc OS 3.1
  387. and Adam Goodfellow for letting me use his AcornLogo sprite.
  388. The authors of DeskLib (for obvious reasons)
  389.  
  390. --------------------
  391. - Copyright notice -
  392. --------------------
  393. Except for the addition of special icons this application may NOT be altered.
  394. Nor may it be distributed for profit without my approval, this includes
  395. distribution as an 'extra' with commercial products, however should you wish
  396. to do so you are welcome to contact me do discuss details. A small charge to
  397. cover copying and media is acceptable.
  398.  
  399. This program is SHAREWARE, if you use it regularly you must register as a user.
  400. Registered users will be entitled to receive free upgrades (see below) and
  401. improved support. The cost of registration is 15 Deutschmarks or 5 UK pounds
  402. including a disc with the latest version of MegaBoard.
  403. Please make all payments in cash only. Users outside the UK or Germany may
  404. send local currency, it should be equivalent to 15 Deutschmarks. (No coins
  405. please. Should the amount sent exceed DM 15, you will be entitled to receive
  406. upgrades free of P&P equivalent to the excess amount.)
  407.  
  408. Send registrations, comments, bug reports etc. to:
  409.  
  410. Sham Gardner
  411. Vorderstr 19
  412. 76189 Karlsruhe
  413. GERMANY
  414.  
  415. or EMail: un9l@rz.uni-karlsruhe.de
  416.  
  417. Upgrades
  418. --------
  419. Registered users can receive upgrades as follows:
  420.  
  421. From within Germany: Send a disc and a stamped-addressed jiffy bag to the
  422.                      above address.
  423. From outside Germany: Send a disc and the equivalent of 3 Deutschmarks (e.g.
  424.                       1 Pound) to cover P&P to the above address.
  425. Or by EMail from anywhere in the world: Send a short mail to the above
  426.                                         address and I will reply with a
  427.                                         uuencoded archive containing the
  428.                                         latest version of MegaBoard (no P&P
  429.                                         for EMail).
  430.  
  431. -------------------
  432. - Version history -
  433. -------------------
  434.  
  435. 1.00 - First release version
  436.  
  437. 1.01 - Minor bug fixed that occasionally caused icons to disappear.
  438.        Option added to prevent double clicks with Adjust from removing icons.
  439.  
  440. 1.50 - Special icon interface rewritten to require special icons to be
  441.        written in ARM code. Avoiding the unpredictable memory requirements of
  442.        BASIC librarys.
  443.        The three special icons provided with MegaBoard rewritten in ARM code
  444.        to adjust to this requirement.
  445.  
  446. 1.51 - Minor bugs fixed and several little features added.
  447.  
  448. 1.52 - Overview window and option to place directories instead of iconising
  449.        filer windows added.
  450.        iconised windows reopened by their tasks are now automatically
  451.        removed.
  452.  
  453. 1.53 - Selections of objects dragged from filer windows no longer all appear
  454.        in the same spot
  455.  
  456. 1.54 - Bug in special icon placing removed
  457.  
  458. 1.55 - Scaled backdrops now require less memory.
  459.  
  460. 1.61 - * commands '*Pin' and '*BackDrop' supported allowing e.g. textures to
  461.        be set from !Configure.
  462.        Special icon 'AcornLogo' added.
  463.  
  464. 1.62 - Cycled backdrops supported.
  465.  
  466. 1.63 - Changes to the desktop font handled properly.
  467.        The colour picker now always reflects the current backdrop colour.
  468.        Filer and window icon text is either black or white to ensure it is
  469.        readable with any backdrop colour.
  470.        Filer icons whose objects are altered e.g. their have type changed are
  471.        automatically updated to reflect these changes.
  472.  
  473. 1.64 - Facility to move icons to the front or back of the heap added.
  474.        Window icons not longer slow down the system.
  475.  
  476. 1.65 - Option added to auto-scale backdrops to fit the screen size in OS
  477.        units not pixels.
  478.  
  479. 1.66 - Minor bug fixes.
  480.        Special icon parameters are now edited using a dialogue box instead of a
  481.        cumbersome submenu structure.
  482.  
  483. 1.67 - Option to save as additional items added.
  484.  
  485. 1.68 - "Navigator" feature added
  486.  
  487. 1.69 - Multiple surfaces feature added.
  488.  
  489. 1.70 - Adapted to work with versions of Risc OS earlier than 3.5.
  490.  
  491. 1.71 - Bug concerning tiled backdrops removed.
  492.  
  493. 1.73 - Bug causing icons to be incorrectly redrawn when using the system font
  494.        removed.
  495.  
  496. 1.74 - Bug involving the redraw of window icons removed.
  497.  
  498. 1.75 - Bug causing crashes with certain backdrop sprites fixed.
  499.        System font handling improved.
  500.        Acorn allocated filetype (&11C) used for configuration files.
  501.  
  502. 1.76 - Bug preventing access to iconized windows on removed surfaces fixed
  503.  
  504. 2.00 - Complete rewrite in C
  505.        Spyhole added
  506.        Many minor enhancements
  507.  
  508. 2.01 - Error in the template file removed
  509.  
  510. 2.02 - Relevent modules included
  511.  
  512. 2.03 - Custom colourpicker added, for cases when the Risc OS colourpicker is
  513.        unavailable.
  514.  
  515. 2.04 - Bug causing the spyhole to become hidden even immediately after.
  516.        pressing ctrl-insert fixed.
  517.        Icon bar added to the overview window.
  518.        The spyhole no longer flickers when dragged to the top of the screen.
  519.  
  520. 2.05 - Several minor bugs fixed.
  521.  
  522. 2.06 - The Spyhole can't be coverd by other windows.
  523.        Spyhole keypress changed to Alt-F1.
  524.        Bug causing the Wimp colour picker to crash fixed.
  525.        Bug concerning auto-removal of window icons fixed.
  526.  
  527. 2.07 - Communication with the support module improved.
  528.        Overview drags improved.
  529.